babl.h: add documentation

diff --git a/babl/babl-internal.h b/babl/babl-internal.h
index 392d786b607fc59579491f88f4135c29659bcead..ee920ed97e71a1e9829908ea3fbd0c10910ce964 100644 (file)
--- a/babl/babl-internal.h
+++ b/babl/babl-internal.h
@@ -455,6 +455,11 @@ void _babl_fish_prepare_bpp (Babl *babl);
  * the result is allocated with malloc and you should free it when done.
  */
 
+typedef enum {
+  BABL_ICC_DEFAULTS = 0,
+  BABL_ICC_COMPACT_TRC_LUT = 1,
+} BablICCFlags;
+
 char *babl_space_to_icc (const Babl  *space,
                          const char  *description,
                          const char  *copyright,

diff --git a/babl/babl.h b/babl/babl.h
index c6052e752ae49af3a5cd88924ea338518ae6048e..660138f72d01bceb01974cf56ffbee8d2f1d1ca2 100644 (file)
--- a/babl/babl.h
+++ b/babl/babl.h
@@ -494,13 +494,9 @@ const Babl * babl_trc_gamma (double gamma);
  */
 const Babl * babl_trc (const char *name);
 
-typedef enum {
-  BABL_ICC_DEFAULTS = 0,
-  BABL_ICC_COMPACT_TRC_LUT = 1,
-} BablICCFlags;
-
 
-/* babl_space_get:
+/**
+ * babl_space_get:
  *
  * query thechromaticities of white point and primaries as well as trcs
  * used for r g a nd b, all arguments mights be NULL.
@@ -515,6 +511,19 @@ void babl_space_get (const Babl *space,
                      const Babl **green_trc,
                      const Babl **blue_trc);
 
+/**
+ * babl_space_get_icc:
+ *
+ * Return pointer to ICC profile for space note that this is
+ * the ICC profile for R'G'B', though in formats only supporting linear
+ * like EXR GEGL chooses to load this lienar data as RGB and use the sRGB
+ * TRC.
+ *
+ * @babl: a BablSpace
+ * @length: point to an integer where length of profile in bytes is stored.
+ *
+ * Returns pointer to ICC profile data.
+ */
 const char *babl_space_get_icc (const Babl *babl, int *length);
 
 #ifdef __cplusplus